[Internal]Enabled Netty Buffer Leak detection and left-over CosmsoClient instance detection during test execution #47211
+3,160
−1,936
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…mos/encryption/CosmosNettyLeakDetectorFactory.java Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
…to users/fabianm/TestImprovements
FabianMeiswinkel
requested review from
a team and
kirankumarkolli
as code owners
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR adds comprehensive leak detection infrastructure for the Azure Cosmos SDK, enabling detection of both Cosmos client leaks and Netty resource leaks during testing. The implementation includes a new stack trace utility, client lifecycle tracking, custom Netty leak detection, and integration with TestNG test infrastructure.
Key Changes:
- Added
StackTraceUtilfor capturing and formatting stack traces to aid in leak diagnosis - Implemented client leak tracking in
RxDocumentClientImplusing a thread-safe map synchronized withstaticLock - Created custom
CosmosNettyLeakDetectorFactoryto detect Netty ByteBuf leaks with detailed logging
Reviewed Changes
Copilot reviewed 44 out of 44 changed files in this pull request and generated 12 comments.
Show a summary per file
| File | Description |
|---|---|
StackTraceUtil.java |
New utility class for capturing and formatting stack traces with comprehensive JavaDoc |
RxDocumentClientImpl.java |
Added client lifecycle tracking with activeClients map and getActiveClientsSnapshot() API |
Configs.java |
Added CLIENT_LEAK_DETECTION_ENABLED configuration with temporary default value requiring revert |
CosmosNettyLeakDetectorFactory.java (tests and encryption) |
Custom Netty leak detector with TestNG listener integration for paranoid-level leak detection |
TestSuiteBase.java (rx, implementation, encryption) |
Added @BeforeClass/@AfterClass hooks for leak detection with snapshot comparison |
CosmosDiagnosticsE2ETest.java |
Added proper client cleanup in try-finally blocks |
Multiple *-testng.xml files |
Registered CosmosNettyLeakDetectorFactory as TestNG listener across all test suites |
KafkaCosmosTestSuiteBase.java |
Changed @BeforeSuite/@AfterSuite methods from static to instance |
pom.xml (kafka-connect) |
Added Maven Central repository entry |
sdk/cosmos/azure-cosmos/src/main/java/com/azure/cosmos/implementation/Configs.java
Outdated
Show resolved
Hide resolved
sdk/cosmos/azure-cosmos/src/main/java/com/azure/cosmos/implementation/RxDocumentClientImpl.java
Outdated
Show resolved
Hide resolved
sdk/cosmos/azure-cosmos/src/main/java/com/azure/cosmos/implementation/RxDocumentClientImpl.java
Outdated
Show resolved
Hide resolved
sdk/cosmos/azure-cosmos-tests/src/test/java/com/azure/cosmos/rx/TestSuiteBase.java
Outdated
Show resolved
Hide resolved
sdk/cosmos/azure-cosmos-tests/src/test/java/com/azure/cosmos/implementation/TestSuiteBase.java
Outdated
Show resolved
Hide resolved
sdk/cosmos/azure-cosmos-tests/src/test/java/com/azure/cosmos/implementation/TestSuiteBase.java
Outdated
Show resolved
Hide resolved
sdk/cosmos/azure-cosmos-encryption/src/test/java/com/azure/cosmos/encryption/TestSuiteBase.java
Outdated
Show resolved
Hide resolved
sdk/cosmos/azure-cosmos-tests/src/test/java/com/azure/cosmos/CosmosDiagnosticsE2ETest.java
Show resolved
Hide resolved
sdk/cosmos/azure-cosmos-tests/src/test/java/com/azure/cosmos/CosmosAsyncClientTest.java
Show resolved
Hide resolved
xinlian12
reviewed
Nov 18, 2025
xinlian12
reviewed
Nov 18, 2025
…to users/fabianm/NettyBufferLeakFixes
Member
Author
|
/azp run java - cosmos - tests |
Member
Author
|
/azp run java - cosmos - kafka |
Member
Author
|
/azp run java - cosmos - spark |
|
Azure Pipelines successfully started running 1 pipeline(s). |
2 similar comments
|
Azure Pipelines successfully started running 1 pipeline(s). |
|
Azure Pipelines successfully started running 1 pipeline(s). |
xinlian12
approved these changes
Nov 18, 2025
Member
xinlian12
left a comment
xinlian12
left a comment
There was a problem hiding this comment.
LGTM, thanks for this great effort to improve the test pipelines :)
.../main/java/com/azure/cosmos/implementation/directconnectivity/rntbd/RntbdRequestDecoder.java
Outdated
Show resolved
Hide resolved
…ntation/directconnectivity/rntbd/RntbdRequestDecoder.java Co-authored-by: Annie Liang <64233642+xinlian12@users.noreply.github.com>
Member
Author
|
/azp run java - cosmos - tests |
Member
Author
|
/azp run java - cosmos - kafka |
Member
Author
|
/azp run java - cosmos - spark |
|
Azure Pipelines successfully started running 1 pipeline(s). |
2 similar comments
|
Azure Pipelines successfully started running 1 pipeline(s). |
|
Azure Pipelines successfully started running 1 pipeline(s). |
Member
Author
|
/check-enforcer override |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
The main purpose of this test is to hook up leak detection for Netty buffers and left-over CosmosClient instances in tests. The reason for it is to get better ocnfidence that there are no memory leaks.
The core logic is in
sdk/cosmos/azure-cosmos-tests/src/test/java/com/azure/cosmos/CosmosNettyLeakDetectorFactory.java- it automatically captures snapshots of already existing cleints and hooks up netty leak detection before/after tests for a test class are executed. This way any leaks are associated with at least the corresponding test class - for few tests whre I saw flakiness or I had to debug I also added netty buffer leak detection per method (but that comes with some overhead ebcause system.gc() is needed after each method with appropriate delay for GC to finish.Product code changes are gated on netty buffer leak detction being paranoid - so, should not cause any overhead.
All SDK Contribution checklist:
General Guidelines and Best Practices
Testing Guidelines